PAYSLE決済

PAYSLE決済（事業者アプリ方式） API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却

EntryTranPaysle 取引登録

決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字6桁
利用金額

利用金額＋税送料が1円～300,000円である必要があります。

Tax 半角数字6桁
税送料

PaymentType 必須
決済タイプ

下記を指定してください。
2：事業者アプリ方式

URL
/payment/EntryTranPaysle.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=100&PaymentType=2
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

ExecTranPaysle 決済実行(事業者アプリ方式)

決済処理を受け付けます。PAYSLEに電子バーコード作成依頼を行います。電子バーコード作成依頼が成功すると、支払い用バーコードデータを返却します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PaymentTermDay 半角数字3桁
支払期限日数

バーコードの支払期限日数です。
1～170まで指定できます。
・決済実行日が2018年1月1日の場合
支払期限日数に1を指定すると、支払期限日は2018年1月2日になります。
支払期限日数に170を指定すると、支払期限日は2018年6月20日になります。
省略時は、ショップ情報に設定された支払期限日数で処理されます。
支払期限日数の初期値は「30」です。
変更する際はショップ管理画面より変更してください。
DeviceName 必須 半角英数記号20桁
機種名

F-06E 、iPhone12,1 の様に、設定してください。
iPhone の場合、 InternalName(iPhone 7 Plus の場合、 iPhone9,2) を設定してください

OsVersion 必須 半角数字記号10桁
OSバージョン

Androidの場合"7.0"、iPhoneの場合"11.1.2"の様に、設定してください。

WinWidth 必須 半角数字5桁
画面横幅

1～99999まで指定できます。

WinHeight 必須 半角数字5桁
画面縦幅

1～99999まで指定できます。

Xdpi 半角数字6桁
画面横方向dpi

Android端末の場合は必須ですが、iPhoneの場合は設定不要です。
1～999999まで指定できます。

Ydpi 半角数字6桁
画面縦方向dpi

Android端末の場合は必須ですが、iPhoneの場合は設定不要です。
1～999999まで指定できます。

URL
/payment/ExecTranPaysle.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&DeviceName=iPhone9,2&OsVersion=11.1.2&WinWidth=500&WinHeight=1000
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status
現状態

処理成功時は以下のステータスが返却されます。
REQSUCCESS：要求成功

TranDate 半角数字14桁 固定
決済日付

yyyyMMddHHmmss形式

PayslePaymentTerm 半角数字8桁 固定
支払期限日

バーコードの支払期限日を返却します。
yyyyMMdd書式

PaysleOrderSerial 半角英数18桁
注文管理ID

PAYSLE事業者が発行する注文管理IDです。

PaysleBarcodeWidth 半角数字5桁
バーコードイメージ横幅

単位はpxです。

PaysleBarcodeHeight 半角数字5桁
バーコードイメージ縦幅

単位はpxです。

PaysleBarcodeFormat 半角英字10桁 固定
バーコードイメージ形式

jpg／png／bmp

PaysleBarcode
バーコードデータ

BASE64でエンコードされた文字列を返却します。

CheckString 半角英数32桁
MD5ハッシュ

OrderID,AccessID,ShopID,ShopPassを連結しMD5ハッシュした値を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=REQSUCCESS&TranDate=20220801121212&PayslePaymentTerm=20220801&PaysleOrderSerial=1234567&PaysleBarcodeWidth=&PaysleBarcodeHeight=&PaysleBarcodeFormat=jpg&PaysleBarcode=&CheckString=660e54b845g14ed03e8cf807a6skjh87
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

PaysleCancel 支払停止

支払停止処理を受け付けます。
お客様の誤入金を防止するため、支払停止を行った際は速やかにチェックマーク付きの支払い済みバーコードを表示するか非表示にしてください。
チェックマーク付きの支払い済みバーコードはバーコード発行処理で取得できます。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

URL
/payment/PaysleCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

Status
現状態

成功時は以下のステータスが返却されます。
CANCEL：支払停止

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CANCEL
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

PaysleBarcode バーコード発行

発行済みバーコードの画像を再取得します。
支払停止済み、支払期限切れ、及び支払い済みの取引に対してバーコード発行を行うと、チェックマーク付きの支払い済みバーコードが返却されます。
お客様の誤入金を防止するため取引が支払停止済み、支払期限切れ、及び支払い済みになった際は速やかにチェックマーク付きの支払い済みバーコードを表示するか、すでに取得済みのバーコードを非表示にしてください。
※支払停止を行うと、即時にチェックマーク付きの支払い済みバーコードが取得できます。
※お客様がお支払手続きを行った後、1分～6分ほど経過するとチェックマーク付きの支払い済みバーコードが取得できます。
※支払停止済み、支払期限切れ、及び支払い済みになった取引は5日以内であればチェックマーク付きの支払い済みバーコードが取得することができます。
※チェックマーク付きの支払い済みバーコードを取得することができる期間は、取引が支払停止済み、支払期限切れ、及び支払い済みになってから5日以内です。1月1日に支払停止した取引は1月5日中までチェックマーク付きの支払い済みバーコードが取得できます。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

DeviceName 必須 半角英数記号20桁
機種名

F-06E 、iPhone12,1 の様に、設定してください。
iPhone の場合、 InternalName(iPhone 7 Plus の場合、 iPhone9,2) を設定してください

OsVersion 必須 半角数字記号10桁
OSバージョン

Androidの場合"7.0"、iPhoneの場合"11.1.2"の様に、設定してください。

WinWidth 必須 半角数字5桁
画面横幅

1～99999まで指定できます。

WinHeight 必須 半角数字5桁
画面縦幅

1～99999まで指定できます。

Xdpi 半角数字6桁
画面横方向dpi

Android端末の場合は必須ですが、iPhoneの場合は設定不要です。
1～999999まで指定できます。

Ydpi 半角数字6桁
画面縦方向dpi

Android端末の場合は必須ですが、iPhoneの場合は設定不要です。
1～999999まで指定できます。

URL
/payment/PaysleBarcode.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&DeviceName=iPhone9,2&OsVersion=11.1.2&WinWidth=500&WinHeight=1000
レスポンス
正常
OrderID 半角英数記号27桁
オーダーID

PaysleBarcodeWidth 半角数字5桁
バーコードイメージ横幅

単位はpxです。

PaysleBarcodeHeight 半角数字5桁
バーコードイメージ縦幅

単位はpxです。

PaysleBarcodeFormat 半角英字3桁 固定
バーコードイメージ形式

jpg／png／bmp

PaysleBarcode
バーコードデータ

BASE64でエンコードされた文字列を返却します。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
OrderID=ORDER0000001&PaysleBarcodeWidth=&PaysleBarcodeHeight=&PaysleBarcodeFormat=jpg&PaysleBarcode=
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

指定したオーダーIDの取引情報を取得します。

リクエスト
ShopID 必須 半角英数13桁
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁
決済方法

35：PAYSLE

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=35
レスポンス
正常
Status
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
PAYSUCCESS：決済完了
CANCEL：支払停止

ProcessDate 半角数字14桁 固定
処理日時

yyyyMMddHHmmss形式

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Amount 半角数字10桁
利用金額

Tax 半角数字10桁
税送料

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

35：PAYSLE

PayslePaymentTerm 半角数字8桁 固定
支払期限日

バーコードの支払期限日を返却します。
yyyyMMdd形式

PaysleOrderSerial 18桁
注文管理ID

PaysleBarcodeWidth 半角数字5桁
バーコードイメージ横幅

単位はpxです。

PaysleBarcodeHeight 半角数字5桁
バーコードイメージ縦幅

単位はpxです。

PaysleBarcodeFormat 半角英字10桁 固定
バーコードイメージ形式

jpg／png／bmp

PaysleResultCode 半角数字1桁 固定
収納結果

1：支払い 2：確定 3：支払取消

FinishDate 半角数字14桁 固定
支払日時

yyyyMMddHHmmss書式

PaysleBarcode
バーコードデータ

BASE64でエンコードされた文字列です。

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=PAYSUCCESS&ProcessDate=20220801121212&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=0&ClientField1=&ClientField2=&ClientField3=&PayType=35&PayslePaymentTerm=20220810&PaysleOrderSerial=123456&PaysleBarcodeWidth=&PaysleBarcodeHeight=&PaysleBarcodeFormat=jpg&PaysleResultCode=2&FinishDate=20220801121212&PaysleBarcode=
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001